Add OP Scan block explorer to Optimism Docs #1129
Conversation
✅ Deploy Preview for docs-optimism ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
📝 Walkthrough📝 WalkthroughWalkthroughThe pull request introduces a new tool called "OP Scan Block Explorer" by adding an entry to the JSON object in Possibly related PRs
Suggested labels
Suggested reviewers
📜 Recent review detailsConfiguration used: .coderabbit.yaml 📒 Files selected for processing (1)
🚧 Files skipped from review as they are similar to previous changes (1)
Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media? 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (Invoked using PR comments)
Other keywords and placeholders
Documentation and Community
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Outside diff range and nitpick comments (5)
pages/builders/chain-operators/tools/op-scan.mdx (5)
1-5: Apply sentence case to title and descriptionAccording to the coding guidelines, headers should use sentence case. Update the frontmatter:
--- -title: op-scan +title: OP Scan lang: en-US -description: Learn how to launch OP Scan, a block explorer designed for your OP Stack chain. +description: Learn how to launch OP Scan, a block explorer designed for your OP Stack chain ---
30-33: Use correct terminology and consider version requirements
- Use "Node.js" instead of "NodeJS"
- Consider using more flexible version requirements to avoid unnecessary restrictions
NodeJS >= 22 pnpm >= 9 + +Note: Node.js 20 LTS should also be compatible.
49-75: Improve writing style and grammarThe text contains repetitive phrasing and missing punctuation:
-You will need to copy `.env.local.example` into `.env.local` at the root of your repository and populate it with your own values. -In particular you will need to provide configuration for both L1 and L2 chains: +Copy `.env.local.example` into `.env.local` at the root of your repository and populate it with your own values. +In particular, configure both L1 and L2 chains: -You will also need to provide your L1 contracts addresses when using a devnet: +For devnet usage, specify the L1 contract addresses:🧰 Tools
🪛 LanguageTool
[uncategorized] ~51-~51: A comma is probably missing here.
Context: ...d populate it with your own values. In particular you will need to provide configuration ...(MISSING_COMMA_AFTER_INTRODUCTORY_PHRASE)
[style] ~64-~64: You have already used this phrasing in nearby sentences. Consider replacing it to add variety to your writing.
Context: ...s://www.quicknode.com/). You will also need to provide your L1 contracts addresses whe...(REP_NEED_TO_VB)
[style] ~72-~72: You have already used this phrasing in nearby sentences. Consider replacing it to add variety to your writing.
Context: .../L1Contract.json`. Note that you always need to provide the proxy address, not the unde...(REP_NEED_TO_VB)
84-90: Fix grammar in database configurationAddress grammar issues and improve clarity:
-To run the indexer, you first need to setup your `DATABASE_URL` in `.env.local` (we use SQLite by default but you can switch to PostgreSQL by changing the Prisma provider in `prisma/schema.prisma`) as well as websocket connections to your L1/L2 chains: +To run the indexer, first set up your `DATABASE_URL` in `.env.local` (we use SQLite by default, but you can switch to PostgreSQL by changing the Prisma provider in `prisma/schema.prisma`) and configure websocket connections to your L1/L2 chains:🧰 Tools
🪛 LanguageTool
[grammar] ~84-~84: The word “setup” is a noun. The verb is spelled with a space.
Context: ... To run the indexer, you first need to setup yourDATABASE_URLin.env.local(we...(NOUN_VERB_CONFUSION)
[uncategorized] ~84-~84: Use a comma before ‘but’ if it connects two independent clauses (unless they are closely connected and short).
Context: ...n.env.local(we use SQLite by default but you can switch to PostgreSQL by changin...(COMMA_COMPOUND_SENTENCE)
161-165: Add missing comma after introductory wordFix grammar:
-Alternatively you can launch the explorer in dev mode if you want to customize it: +Alternatively, you can launch the explorer in dev mode if you want to customize it:
📜 Review details
Configuration used: .coderabbit.yaml
Review profile: CHILL
📒 Files selected for processing (2)
pages/builders/chain-operators/tools/_meta.json(1 hunks)pages/builders/chain-operators/tools/op-scan.mdx(1 hunks)
✅ Files skipped from review due to trivial changes (1)
- pages/builders/chain-operators/tools/_meta.json
🧰 Additional context used
📓 Path-based instructions (1)
pages/builders/chain-operators/tools/op-scan.mdx (1)
Pattern **/*.mdx: "ALWAYS review Markdown content THOROUGHLY with the following criteria:
- Use proper nouns in place of personal pronouns like 'We' and 'Our' to maintain consistency in communal documentation.
- Avoid gender-specific language and use the imperative form.
- Monitor capitalization for emphasis. Avoid using all caps, italics, or bold for emphasis.
- Ensure proper nouns are capitalized in sentences.
- Apply the Oxford comma.
- Use proper title case for buttons, tab names, page names, and links. Sentence case should be used for body content and short phrases, even in links.
- Use correct spelling and grammar at all times (IMPORTANT).
- For H1, H2, and H3 headers:
- Use sentence case, capitalizing only the first word.
- Preserve the capitalization of proper nouns, technical terms, and acronyms as defined in the 'nouns.txt' file located in the root directory of the project.
- Do not automatically lowercase words that appear in the 'nouns.txt' file, regardless of their position in the header.
- Flag any headers that seem to inconsistently apply these rules for manual review.
- When reviewing capitalization, always refer to the 'nouns.txt' file for the correct capitalization of proper nouns and technical terms specific to the project.
"
🪛 LanguageTool
pages/builders/chain-operators/tools/op-scan.mdx
[uncategorized] ~51-~51: A comma is probably missing here.
Context: ...d populate it with your own values. In particular you will need to provide configuration ...
(MISSING_COMMA_AFTER_INTRODUCTORY_PHRASE)
[style] ~64-~64: You have already used this phrasing in nearby sentences. Consider replacing it to add variety to your writing.
Context: ...s://www.quicknode.com/). You will also need to provide your L1 contracts addresses whe...
(REP_NEED_TO_VB)
[style] ~72-~72: You have already used this phrasing in nearby sentences. Consider replacing it to add variety to your writing.
Context: .../L1Contract.json`. Note that you always need to provide the proxy address, not the unde...
(REP_NEED_TO_VB)
[style] ~76-~76: You have already used this phrasing in nearby sentences. Consider replacing it to add variety to your writing.
Context: ...re on verified contracts, you will also need to provide a [Reown](https://docs.reown.co...
(REP_NEED_TO_VB)
[grammar] ~84-~84: The word “setup” is a noun. The verb is spelled with a space.
Context: ... To run the indexer, you first need to setup your DATABASE_URL in .env.local (we...
(NOUN_VERB_CONFUSION)
[uncategorized] ~84-~84: Use a comma before ‘but’ if it connects two independent clauses (unless they are closely connected and short).
Context: ...n .env.local (we use SQLite by default but you can switch to PostgreSQL by changin...
(COMMA_COMPOUND_SENTENCE)
[uncategorized] ~104-~104: Use a comma before ‘and’ if it connects two independent clauses (unless they are closely connected and short).
Context: ... blocks getting indexed in your terminal and you can explore the state of your local...
(COMMA_COMPOUND_SENTENCE)
[style] ~117-~117: Specify a number, remove phrase, or simply use “many” or “numerous”
Context: ... load on the RPC as you need to perform a large number of JSON-RPC requests to fully index a bloc...
(LARGE_NUMBER_OF)
[uncategorized] ~155-~155: Use a comma before “and” if it connects two independent clauses (unless they are closely connected and short).
Context: ...` Make sure your local chain is started and the indexer is running, then launch the...
(COMMA_COMPOUND_SENTENCE_2)
[typographical] ~160-~160: Consider adding a comma after ‘Alternatively’ for more clarity.
Context: .../localhost:3000` sh pnpm start Alternatively you can launch the explorer in dev mode...
(RB_LY_COMMA)
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Outside diff range and nitpick comments (8)
pages/builders/chain-operators/tools/op-scan.mdx (8)
9-9: Adjust header formatting for consistencyAccording to the coding guidelines, H1 headers should use sentence case. Consider changing to:
-# 🔎 OP Scan +# 🔎 Op scan
66-68: Add placeholder indicators for contract addressesMake it clearer that these values need to be replaced by adding placeholder indicators:
-NEXT_PUBLIC_OPTIMISM_PORTAL_ADDRESS="..." -NEXT_PUBLIC_L1_CROSS_DOMAIN_MESSENGER_ADDRESS="..." +NEXT_PUBLIC_OPTIMISM_PORTAL_ADDRESS="<your-optimism-portal-address>" +NEXT_PUBLIC_L1_CROSS_DOMAIN_MESSENGER_ADDRESS="<your-l1-cross-domain-messenger-address>"
75-79: Add instructions for obtaining Reown project IDConsider adding instructions or a link explaining how to obtain a Reown project ID for the Write Contract feature.
103-103: Add comma for better readabilityAdd a comma before "and" to improve readability:
-You should start seeing blocks getting indexed in your terminal and you can explore the state of your local database using Prisma studio: +You should start seeing blocks getting indexed in your terminal, and you can explore the state of your local database using Prisma studio:🧰 Tools
🪛 LanguageTool
[uncategorized] ~103-~103: Use a comma before ‘and’ if it connects two independent clauses (unless they are closely connected and short).
Context: ... blocks getting indexed in your terminal and you can explore the state of your local...(COMMA_COMPOUND_SENTENCE)
116-117: Improve clarity of indexing load descriptionRevise the sentence for better clarity:
-Indexing a blockchain is putting a heavy load on the RPC as you need to perform a large number of JSON-RPC requests to fully index a block (along with transactions and logs). +Indexing a blockchain puts a heavy load on the RPC because it requires numerous JSON-RPC requests to fully index each block (along with transactions and logs).🧰 Tools
🪛 LanguageTool
[uncategorized] ~116-~116: This verb may not be in the correct tense. Consider changing the tense to fit the context better.
Context: ...isma:db:push ``` Indexing a blockchain is putting a heavy load on the RPC as you need to ...(AI_EN_LECTOR_REPLACEMENT_VERB_TENSE)
[style] ~116-~116: Specify a number, remove phrase, or simply use “many” or “numerous”
Context: ... load on the RPC as you need to perform a large number of JSON-RPC requests to fully index a bloc...(LARGE_NUMBER_OF)
143-143: Add context to example block numbersConsider adding comments to explain what these block numbers represent or use more meaningful example values.
154-154: Add comma for better readabilityAdd a comma before "and" to improve readability:
-Make sure your local chain is started and the indexer is running, then launch the explorer to see it live at `http://localhost:3000` +Make sure your local chain is started, and the indexer is running, then launch the explorer to see it live at `http://localhost:3000`🧰 Tools
🪛 LanguageTool
[uncategorized] ~154-~154: Use a comma before “and” if it connects two independent clauses (unless they are closely connected and short).
Context: ...` Make sure your local chain is started and the indexer is running, then launch the...(COMMA_COMPOUND_SENTENCE_2)
160-164: Add development mode benefitsConsider explaining the benefits of using development mode, such as hot reloading or debugging capabilities.
📜 Review details
Configuration used: .coderabbit.yaml
Review profile: CHILL
📒 Files selected for processing (1)
pages/builders/chain-operators/tools/op-scan.mdx(1 hunks)
🧰 Additional context used
📓 Path-based instructions (1)
pages/builders/chain-operators/tools/op-scan.mdx (1)
Pattern **/*.mdx: "ALWAYS review Markdown content THOROUGHLY with the following criteria:
- Use proper nouns in place of personal pronouns like 'We' and 'Our' to maintain consistency in communal documentation.
- Avoid gender-specific language and use the imperative form.
- Monitor capitalization for emphasis. Avoid using all caps, italics, or bold for emphasis.
- Ensure proper nouns are capitalized in sentences.
- Apply the Oxford comma.
- Use proper title case for buttons, tab names, page names, and links. Sentence case should be used for body content and short phrases, even in links.
- Use correct spelling and grammar at all times (IMPORTANT).
- For H1, H2, and H3 headers:
- Use sentence case, capitalizing only the first word.
- Preserve the capitalization of proper nouns, technical terms, and acronyms as defined in the 'nouns.txt' file located in the root directory of the project.
- Do not automatically lowercase words that appear in the 'nouns.txt' file, regardless of their position in the header.
- Flag any headers that seem to inconsistently apply these rules for manual review.
- When reviewing capitalization, always refer to the 'nouns.txt' file for the correct capitalization of proper nouns and technical terms specific to the project.
"
🪛 LanguageTool
pages/builders/chain-operators/tools/op-scan.mdx
[uncategorized] ~103-~103: Use a comma before ‘and’ if it connects two independent clauses (unless they are closely connected and short).
Context: ... blocks getting indexed in your terminal and you can explore the state of your local...
(COMMA_COMPOUND_SENTENCE)
[uncategorized] ~116-~116: This verb may not be in the correct tense. Consider changing the tense to fit the context better.
Context: ...isma:db:push ``` Indexing a blockchain is putting a heavy load on the RPC as you need to ...
(AI_EN_LECTOR_REPLACEMENT_VERB_TENSE)
[style] ~116-~116: Specify a number, remove phrase, or simply use “many” or “numerous”
Context: ... load on the RPC as you need to perform a large number of JSON-RPC requests to fully index a bloc...
(LARGE_NUMBER_OF)
[uncategorized] ~154-~154: Use a comma before “and” if it connects two independent clauses (unless they are closely connected and short).
Context: ...` Make sure your local chain is started and the indexer is running, then launch the...
(COMMA_COMPOUND_SENTENCE_2)
There was a problem hiding this comment.
Actionable comments posted: 2
🧹 Outside diff range and nitpick comments (5)
pages/builders/chain-operators/tools/op-scan.mdx (5)
9-9: Adjust header formattingThe H1 header contains an emoji followed by "OP Scan". According to the coding guidelines, headers should use sentence case while preserving the capitalization of proper nouns. The current format is acceptable, but consider moving the emoji to a separate line or removing it for consistency with documentation standards.
40-40: Consider using HTTPS URL for git cloneThe git clone command uses SSH format which might not work for users without SSH keys configured. Consider providing the HTTPS URL alternative:
-git clone [email protected]:walnuthq/op-scan +git clone https://github.com/walnuthq/op-scan.git
116-116: Add comma for better readabilityAdd a comma after "RPC" to improve sentence structure:
-Indexing a blockchain puts a heavy load on the RPC as you need to perform many JSON-RPC requests to fully index a block (along with transactions and logs). +Indexing a blockchain puts a heavy load on the RPC, as you need to perform many JSON-RPC requests to fully index a block (along with transactions and logs).🧰 Tools
🪛 LanguageTool
[uncategorized] ~116-~116: Possible missing comma found.
Context: ...g a blockchain puts a heavy load on the RPC as you need to perform many JSON-RPC re...(AI_HYDRA_LEO_MISSING_COMMA)
148-148: Add comma for better readabilityAdd a comma after "variables" to improve sentence structure:
-When you're done configuring your environment variables you can build the app: +When you're done configuring your environment variables, you can build the app:🧰 Tools
🪛 LanguageTool
[uncategorized] ~148-~148: Possible missing comma found.
Context: ...ou're done configuring your environment variables you can build the app: ```sh pnpm buil...(AI_HYDRA_LEO_MISSING_COMMA)
154-158: Add port number informationWhile the port number (3000) is mentioned in the text, consider adding it to the command section for better visibility. Also, consider mentioning if this port can be configured through environment variables.
📜 Review details
Configuration used: .coderabbit.yaml
Review profile: CHILL
📒 Files selected for processing (1)
pages/builders/chain-operators/tools/op-scan.mdx(1 hunks)
🧰 Additional context used
📓 Path-based instructions (1)
pages/builders/chain-operators/tools/op-scan.mdx (1)
Pattern **/*.mdx: "ALWAYS review Markdown content THOROUGHLY with the following criteria:
- Use proper nouns in place of personal pronouns like 'We' and 'Our' to maintain consistency in communal documentation.
- Avoid gender-specific language and use the imperative form.
- Monitor capitalization for emphasis. Avoid using all caps, italics, or bold for emphasis.
- Ensure proper nouns are capitalized in sentences.
- Apply the Oxford comma.
- Use proper title case for buttons, tab names, page names, and links. Sentence case should be used for body content and short phrases, even in links.
- Use correct spelling and grammar at all times (IMPORTANT).
- For H1, H2, and H3 headers:
- Use sentence case, capitalizing only the first word.
- Preserve the capitalization of proper nouns, technical terms, and acronyms as defined in the 'nouns.txt' file located in the root directory of the project.
- Do not automatically lowercase words that appear in the 'nouns.txt' file, regardless of their position in the header.
- Flag any headers that seem to inconsistently apply these rules for manual review.
- When reviewing capitalization, always refer to the 'nouns.txt' file for the correct capitalization of proper nouns and technical terms specific to the project.
"
🪛 LanguageTool
pages/builders/chain-operators/tools/op-scan.mdx
[uncategorized] ~116-~116: Possible missing comma found.
Context: ...g a blockchain puts a heavy load on the RPC as you need to perform many JSON-RPC re...
(AI_HYDRA_LEO_MISSING_COMMA)
[uncategorized] ~148-~148: Possible missing comma found.
Context: ...ou're done configuring your environment variables you can build the app: ```sh pnpm buil...
(AI_HYDRA_LEO_MISSING_COMMA)
|
Can we kindly get a review on this PR? For context: this PR is part of our Season 5 grant (link) for building a local-first, lightweight and open-source block explorer for the Superchain. |
Description
This PR is adding a section about OP Scan, a tailor-made Open Source Block Explorer for the OP Stack.
The added section is explaining how to run locally the explorer against either your local devnet or any other OP Stack based chain.
While the primary focus of OP Scan is providing a lightweight explorer you can run locally on a a laptop, we might consider adding more resources on how to host the explorer in production later on.
Additional context
OP Scan is under active development and is looking forward to add key features to complete its goal as being a lightweight explorer aligned with the Superchan vision.
Here's a video walkthrough on how to launch the explorer locally configured for OP Sepolia testnet.
You can test a live version of OP Scan deployed against OP Sepolia at opscan.co.
@krofax Sorry about the false start, opscan.co should be up and running without any hiccup now.